<?xml version="1.0" encoding="UTF-8"?>
<html filename="docs/SAXExt/IDeclHandler.html">
<body>
<a id="#top"/>
<h1>
	                Interface Summary : IDeclHandler </h1> SAX2 extension handler for DTD declaration events.

 <blockquote>
 <em>This module, both source code and documentation, is in the
 Public Domain, and comes with <strong>NO WARRANTY</strong>.</em>
 </blockquote>

 <p>This is an optional extension handler for SAX2 to provide more
 complete information about DTD declarations in an XML document.
 XML readers are not required to recognize this handler, and it
 is not part of core-only SAX2 distributions.</p>

 <p>Note that data-related DTD declarations (unparsed entities and
 notations) are already reported through the <a href="../SAX/IDTDHandler.html">IDTDHandler</a>
 interface.</p>

 <p>If you are using the declaration handler together with a lexical
 handler, all of the events will occur between the
 <a href="../SAXExt/ILexicalHandler.html#startDTD">startDTD</a> and the
 <a href="../SAXExt/ILexicalHandler.html#endDTD">endDTD</a> events.</p>

 <p>To set the DeclHandler for an XML reader, use the
 <a href="../SAX/IXMLReader.html#getProperty">getProperty</a> method
 with the property name
 <code>http://xml.org/sax/properties/declaration-handler</code>
 and an object implementing this interface (or nil) as the value.
 If the reader does not report declaration events, it will throw a
 <a href="../SAX/ESAXNotRecognizedException.html">ESAXNotRecognizedException</a>
 when you attempt to register the handler.</p>

<br/><b>Since : </b> SAX 2.0 (extensions 1.0)
<br/><b>See : </b> <a href="../SAX/IXMLReader.html">IXMLReader</a>

<h2>
	              Methods
	            </h2>
<div style="padding-left:10px">
<a href="#elementDecl">
	                  procedure
	                 elementDecl(SAXString, SAXString)</a>
<br/>
<a href="#attributeDecl">
	                  procedure
	                 attributeDecl(SAXString, SAXString, SAXString, SAXString, SAXString)</a>
<br/>
<a href="#internalEntityDecl">
	                  procedure
	                 internalEntityDecl(SAXString, SAXString)</a>
<br/>
<a href="#externalEntityDecl">
	                  procedure
	                 externalEntityDecl(SAXString, SAXString, SAXString)</a>
<br/>
</div>
<br/>
<hr width="100%"/>
<a name="#elementDecl">
<p>
<b>procedure</b> elementDecl(<b>const</b> name : SAXString; <b>const</b> model : SAXString); </p>
</a> Report an element type declaration.

 <p>The content model will consist of the string &quot;EMPTY&quot;, the
 string &quot;ANY&quot;, or a parenthesised group, optionally followed
 by an occurrence indicator.  The model will be normalized so
 that all parameter entities are fully resolved and all whitespace
 is removed,and will include the enclosing parentheses.  Other
 normalization (such as removing redundant parentheses or
 simplifying occurrence indicators) is at the discretion of the
 parser.</p>

<br/><b>Parameter : </b> name The element type name.
<br/><b>Parameter : </b> model The content model as a normalized string.
<br/><b>Exception : </b> ESAXException The application may raise an exception.
/
<br/>
<p>
<a href="#top">Top</a>
</p>
<hr width="100%"/>
<a name="#attributeDecl">
<p>
<b>procedure</b> attributeDecl(<b>const</b> eName : SAXString; <b>const</b> aName : SAXString; <b>const</b> attrType : SAXString; <b>const</b> mode : SAXString; <b>const</b> value : SAXString); </p>
</a> Report an attribute type declaration.

 <p>Only the effective (first) declaration for an attribute will
 be reported.  The type will be one of the strings &quot;CDATA&quot;,
 &quot;ID&quot;, &quot;IDREF&quot;, &quot;IDREFS&quot;, &quot;NMTOKEN&quot;, &quot;NMTOKENS&quot;, &quot;ENTITY&quot;,
 &quot;ENTITIES&quot;, a parenthesized token group with
 the separator &quot;|&quot; and all whitespace removed, or the word
 &quot;NOTATION&quot; followed by a space followed by a parenthesized
 token group with all whitespace removed.</p>

 <p>The value will be the value as reported to applications,
 appropriately normalized and with entity and character
 references expanded.</p>

<br/><b>Parameter : </b> eName The name of the associated element.
<br/><b>Parameter : </b> aName The name of the attribute.
<br/><b>Parameter : </b> attrType A string representing the attribute type.
 <br/><b>Parameter : </b> mode A string representing the attribute defaulting mode
        (&quot;#IMPLIED&quot;, &quot;#REQUIRED&quot;, or &quot;#FIXED&quot;) or '' if
        none of these applies.
<br/><b>Parameter : </b> value A string representing the attribute's default value,
        or '' if there is none.
<br/><b>Exception : </b> ESAXException The application may raise an exception.
<br/>
<p>
<a href="#top">Top</a>
</p>
<hr width="100%"/>
<a name="#internalEntityDecl">
<p>
<b>procedure</b> internalEntityDecl(<b>const</b> name : SAXString; <b>const</b> value : SAXString); </p>
</a> Report an internal entity declaration.

 <p>Only the effective (first) declaration for each entity
 will be reported.  All parameter entities in the value
 will be expanded, but general entities will not.</p>

<br/><b>Parameter : </b> name The name of the entity.  If it is a parameter
        entity, the name will begin with '%'.
<br/><b>Parameter : </b> value The replacement text of the entity.
<br/><b>Exception : </b> ESAXException The application may raise an exception.
<br/><b>See : </b> <a href="../SAXExt/IDeclHandler.html#externalEntityDecl">IDeclHandler.externalEntityDecl</a>
<br/><b>See : </b> <a href="../SAX/IDTDHandler.html#unparsedEntityDecl">IDTDHandler.unparsedEntityDecl</a>
<br/>
<p>
<a href="#top">Top</a>
</p>
<hr width="100%"/>
<a name="#externalEntityDecl">
<p>
<b>procedure</b> externalEntityDecl(<b>const</b> name : SAXString; <b>const</b> publicId : SAXString; <b>const</b> systemId : SAXString); </p>
</a> Report a parsed external entity declaration.

 <p>Only the effective (first) declaration for each entity
 will be reported.</p>

<br/><b>Parameter : </b> name The name of the entity.  If it is a parameter
        entity, the name will begin with '%'.
<br/><b>Parameter : </b> publicId The declared public identifier of the entity, or
        an empty string if none was declared.
<br/><b>Parameter : </b> systemId The declared system identifier of the entity.
<br/><b>Exception : </b> ESAXException The application may raise an exception.
<br/><b>See : </b> <a href="../SAXExt/IDeclHandler.html#internalEntityDecl">IDeclHandler.internalEntityDecl</a>
<br/><b>See : </b> <a href="../SAX/IDTDHandler.html#unparsedEntityDecl">IDTDHandler.unparsedEntityDecl</a>
<br/>
<p>
<a href="#top">Top</a>
</p>
</body>
</html>